Dokumentacja MAIL REST API 1.0

GET emails/<domain>

Opis
Lista kont pocztowych w obrębie domeny.
Sygnatura polecenia
  • Metoda żądania - GET
  • Ścieżka żądania (URL PATH) - wskazanie domeny pocztowej
  • Parametry żądania (QUERY_STRING) - parametry wpływające na listę wyników poprzez paginację, sortowanie, wyszukiwanie
  • Ciało żądania - puste
  • Ciało odpowiedzi - lista znalezionych kont pocztowych opisanych wybranymi parametrami oraz informacja o liczbie wszystkich pasujących zasobów do zadanych warunków zapytania
Parametry ścieżki:
(string) domain
wymagany Nazwa domeny w obrębie której znajdują się konta pocztowe.
przykładowa wartość: demo.kei.pl
(int) page Numer strony, liczony od zera.
(int) size Ilość pobieranych wierszy w jednym zapytaniu (domyślnie 50).
(string) search Fraza, po której filtrowane będą wyniki zapytania.
(string) sort Pole, po którym wyniki mają być sortowane.
(string) sort_dir Kierunek sortowania wyników - rosnąco czy malejąco.
dopuszczalne wartości:
  • asc: rosnąco
  • desc: malejąco
Struktura odpowiedzi
"result_info":{ 
    "total":  "- liczba wszystkich znalezionych wierszy"
    "fetched": "- liczba zwroconych wierszy"
}
"result_data": { 
    "wynik_wyszukiwania":{
    }
}"
Przykładowe zapytanie:
GET https://as27.demo.kei.pl/v1/emails/demo.kei.pl?page=0&sort=sortowane_pole&search=szukana_fraza&sort_dir=asc&size=50
Przykładowa odpowiedź:
{
    "result_info":{
        "total":2,
        "fetched":2,
        "page_size":50,
        "page":0
    },
    "result_data":{
        "postmaster":{
            "email":"postmaster@demo.kei.pl",
            "creation_date":"",
            "expiration_date":"",
            "last_auth_date":"2014-02-13",
            "capacity":"3",
            "description":"opisdssddik kuddla",
            "blocked":"0",
            "name":"postmaster",
            "domain":"demo.kei.pl",
            "usage":"5%"
        },
        "testowe":{
            "email":"testowe@demo.kei.pl",
            "creation_date":"2014-01-31",
            "expiration_date":"",
            "last_auth_date":"",
            "capacity":"1",
            "description":"opis",
            "blocked":"0",
            "name":"testowe",
            "domain":"demo.kei.pl",
            "usage":"0%"
        }
    }
}